<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Core Plot (Mac OS): CPTAxisLabel Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="core-plot-logo.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Core Plot (Mac OS)
   
   </div>
   <div id="projectbrief">Cocoa plotting framework for Mac OS X and iOS</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Animation&#160;&&#160;Constants</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('interface_c_p_t_axis_label.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">CPTAxisLabel Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="CPTAxisLabel" --><!-- doxytag: inherits="NSObject,NSCoding-p-p" -->
<p>An axis label.  
 <a href="interface_c_p_t_axis_label.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CPTAxisLabel:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="interface_c_p_t_axis_label__inherit__graph.png" border="0" usemap="#_c_p_t_axis_label_inherit__map" alt="Inheritance graph"/></div>
<map name="_c_p_t_axis_label_inherit__map" id="_c_p_t_axis_label_inherit__map">
<area shape="rect" id="node11" href="interface_c_p_t_axis_title.html" title="An axis title." alt="" coords="175,246,277,277"/><area shape="rect" id="node2" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Classes/NSObject_Class/Reference/Reference.html" title="NSObject" alt="" coords="124,86,204,117"/><area shape="rect" id="node4" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="5,6,123,37"/><area shape="rect" id="node6" href="http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/Protocols/NSKeyValueBindingCreation_Protocol/Reference/Reference.html" title="\&lt;NSKeyValueBindingCreation&#45;p\&gt;" alt="" coords="146,6,384,37"/><area shape="rect" id="node8" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Protocols/NSCoding_Protocol/Reference/Reference.html" title="\&lt;NSCoding&#45;p\&gt;" alt="" coords="228,86,349,117"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for CPTAxisLabel:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="interface_c_p_t_axis_label__coll__graph.png" border="0" usemap="#_c_p_t_axis_label_coll__map" alt="Collaboration graph"/></div>
<map name="_c_p_t_axis_label_coll__map" id="_c_p_t_axis_label_coll__map">
<area shape="rect" id="node2" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Classes/NSObject_Class/Reference/Reference.html" title="NSObject" alt="" coords="124,86,204,117"/><area shape="rect" id="node4" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="5,6,123,37"/><area shape="rect" id="node6" href="http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/Protocols/NSKeyValueBindingCreation_Protocol/Reference/Reference.html" title="\&lt;NSKeyValueBindingCreation&#45;p\&gt;" alt="" coords="146,6,384,37"/><area shape="rect" id="node8" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Protocols/NSCoding_Protocol/Reference/Reference.html" title="\&lt;NSCoding&#45;p\&gt;" alt="" coords="228,86,349,117"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_c_p_t_axis_label-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Instance Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Initialization</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">id</a>)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_axis_label.html#a956058856b90fc92a108ec3b6e425b65">initWithText:textStyle:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a newly allocated text-based <a class="el" href="interface_c_p_t_axis_label.html" title="An axis label.">CPTAxisLabel</a> object with the provided text and style.  <a href="#a956058856b90fc92a108ec3b6e425b65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">id</a>)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_axis_label.html#a347ae9b71d25b869deb358f3d4f31f8f">initWithContentLayer:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a newly allocated <a class="el" href="interface_c_p_t_axis_label.html" title="An axis label.">CPTAxisLabel</a> object with the provided layer. This is the designated initializer.  <a href="#a347ae9b71d25b869deb358f3d4f31f8f"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Layout</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_axis_label.html#ac05596d481daa7c69327ea7ef86f8ba7">positionRelativeToViewPoint:forCoordinate:inDirection:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Positions the axis label relative to the given point. The algorithm for positioning is different when the rotation property is non-zero. When zero, the anchor point is positioned along the closest side of the label. When non-zero, the anchor point is left at the center. This has consequences for the value taken by the offset.  <a href="#ac05596d481daa7c69327ea7ef86f8ba7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_axis_label.html#afca6bb437d8cb042f75e88b957d99778">positionBetweenViewPoint:andViewPoint:forCoordinate:inDirection:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Positions the axis label between two given points.  <a href="#afca6bb437d8cb042f75e88b957d99778"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a245de072b2e84433c27fbb7ffe800f18"></a><!-- doxytag: member="CPTAxisLabel::contentLayer" ref="a245de072b2e84433c27fbb7ffe800f18" args="" -->
<a class="el" href="interface_c_p_t_layer.html">CPTLayer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_axis_label.html#a245de072b2e84433c27fbb7ffe800f18">contentLayer</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The label content. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0d38da5269a2136c2b8b728a45a0658"></a><!-- doxytag: member="CPTAxisLabel::offset" ref="ab0d38da5269a2136c2b8b728a45a0658" args="" -->
CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_axis_label.html#ab0d38da5269a2136c2b8b728a45a0658">offset</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The offset distance between the axis and label. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e042aedab0a2c83579c0adbf7d85108"></a><!-- doxytag: member="CPTAxisLabel::rotation" ref="a5e042aedab0a2c83579c0adbf7d85108" args="" -->
CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_axis_label.html#a5e042aedab0a2c83579c0adbf7d85108">rotation</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The rotation of the label in radians. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0d5dc300f7e7d976eda9ef14e224fa1"></a><!-- doxytag: member="CPTAxisLabel::alignment" ref="ac0d5dc300f7e7d976eda9ef14e224fa1" args="" -->
<a class="el" href="_c_p_t_definitions_8h.html#af9221fe6bb5be966fee039fea78c1c36">CPTAlignment</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_axis_label.html#ac0d5dc300f7e7d976eda9ef14e224fa1">alignment</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The alignment of the axis label with respect to the tick mark. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a462594a2b1c4112f051eb8996ef1c2f2"></a><!-- doxytag: member="CPTAxisLabel::tickLocation" ref="a462594a2b1c4112f051eb8996ef1c2f2" args="" -->
<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/Foundation/Miscellaneous/Foundation_DataTypes/Reference/reference.html">NSDecimal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_axis_label.html#a462594a2b1c4112f051eb8996ef1c2f2">tickLocation</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The data coordinate of the ticklocation. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An axis label. </p>
<p>The label can be text-based or can be the content of any <a class="el" href="interface_c_p_t_layer.html" title="Base class for all Core Animation layers in Core Plot.">CPTLayer</a> provided by the user. </p>
</div><hr/><h2>Method Documentation</h2>
<a class="anchor" id="a347ae9b71d25b869deb358f3d4f31f8f"></a><!-- doxytag: member="CPTAxisLabel::initWithContentLayer:" ref="a347ae9b71d25b869deb358f3d4f31f8f" args="(CPTLayer *layer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">id</a>) <a class="el" href="interface_c_p_t_axis_label.html#a347ae9b71d25b869deb358f3d4f31f8f">initWithContentLayer:</a> </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_c_p_t_layer.html">CPTLayer</a> *)&#160;</td>
          <td class="paramname"><em>layer</em></td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes a newly allocated <a class="el" href="interface_c_p_t_axis_label.html" title="An axis label.">CPTAxisLabel</a> object with the provided layer. This is the designated initializer. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">layer</td><td>The label content. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The initialized <a class="el" href="interface_c_p_t_axis_label.html" title="An axis label.">CPTAxisLabel</a> object. </dd></dl>

</div>
</div>
<a class="anchor" id="a956058856b90fc92a108ec3b6e425b65"></a><!-- doxytag: member="CPTAxisLabel::initWithText:textStyle:" ref="a956058856b90fc92a108ec3b6e425b65" args="(NSString *newText,[textStyle] CPTTextStyle *style)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">id</a>) initWithText: </td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Classes/NSString_Class/Reference/NSString.html">NSString</a> *)&#160;</td>
          <td class="paramname"><em>newText</em></td>
        </tr>
        <tr>
          <td class="paramkey">textStyle:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_c_p_t_text_style.html">CPTTextStyle</a> *)&#160;</td>
          <td class="paramname"><em>newStyle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes a newly allocated text-based <a class="el" href="interface_c_p_t_axis_label.html" title="An axis label.">CPTAxisLabel</a> object with the provided text and style. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">newText</td><td>The label text. </td></tr>
    <tr><td class="paramname">newStyle</td><td>The text style for the label. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The initialized <a class="el" href="interface_c_p_t_axis_label.html" title="An axis label.">CPTAxisLabel</a> object. </dd></dl>

</div>
</div>
<a class="anchor" id="afca6bb437d8cb042f75e88b957d99778"></a><!-- doxytag: member="CPTAxisLabel::positionBetweenViewPoint:andViewPoint:forCoordinate:inDirection:" ref="afca6bb437d8cb042f75e88b957d99778" args="(CGPoint firstPoint,[andViewPoint] CGPoint secondPoint,[forCoordinate] CPTCoordinate coordinate,[inDirection] CPTSign direction)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) positionBetweenViewPoint: </td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/documentation/GraphicsImaging/Reference/CGGeometry/Reference/reference.html#//apple_ref/doc/c_ref/CGPoint.html">CGPoint</a>)&#160;</td>
          <td class="paramname"><em>firstPoint</em></td>
        </tr>
        <tr>
          <td class="paramkey">andViewPoint:</td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/documentation/GraphicsImaging/Reference/CGGeometry/Reference/reference.html#//apple_ref/doc/c_ref/CGPoint.html">CGPoint</a>)&#160;</td>
          <td class="paramname"><em>secondPoint</em></td>
        </tr>
        <tr>
          <td class="paramkey">forCoordinate:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_definitions_8h.html#a10709b6abd0a9ee1769345ef51b2fcd7">CPTCoordinate</a>)&#160;</td>
          <td class="paramname"><em>coordinate</em></td>
        </tr>
        <tr>
          <td class="paramkey">inDirection:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_definitions_8h.html#a29f56cced59c093e06eb5abf9be95c35">CPTSign</a>)&#160;</td>
          <td class="paramname"><em>direction</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Positions the axis label between two given points. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">firstPoint</td><td>The first view point. </td></tr>
    <tr><td class="paramname">secondPoint</td><td>The second view point. </td></tr>
    <tr><td class="paramname">coordinate</td><td>The axis coordinate. </td></tr>
    <tr><td class="paramname">direction</td><td>The offset direction. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac05596d481daa7c69327ea7ef86f8ba7"></a><!-- doxytag: member="CPTAxisLabel::positionRelativeToViewPoint:forCoordinate:inDirection:" ref="ac05596d481daa7c69327ea7ef86f8ba7" args="(CGPoint point,[forCoordinate] CPTCoordinate coordinate,[inDirection] CPTSign direction)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) positionRelativeToViewPoint: </td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/documentation/GraphicsImaging/Reference/CGGeometry/Reference/reference.html#//apple_ref/doc/c_ref/CGPoint.html">CGPoint</a>)&#160;</td>
          <td class="paramname"><em>point</em></td>
        </tr>
        <tr>
          <td class="paramkey">forCoordinate:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_definitions_8h.html#a10709b6abd0a9ee1769345ef51b2fcd7">CPTCoordinate</a>)&#160;</td>
          <td class="paramname"><em>coordinate</em></td>
        </tr>
        <tr>
          <td class="paramkey">inDirection:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_definitions_8h.html#a29f56cced59c093e06eb5abf9be95c35">CPTSign</a>)&#160;</td>
          <td class="paramname"><em>direction</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Positions the axis label relative to the given point. The algorithm for positioning is different when the rotation property is non-zero. When zero, the anchor point is positioned along the closest side of the label. When non-zero, the anchor point is left at the center. This has consequences for the value taken by the offset. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">point</td><td>The view point. </td></tr>
    <tr><td class="paramname">coordinate</td><td>The coordinate in which the label is being position. Orthogonal to the axis coordinate. </td></tr>
    <tr><td class="paramname">direction</td><td>The offset direction. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Source/<a class="el" href="_c_p_t_axis_label_8h_source.html">CPTAxisLabel.h</a></li>
<li>Source/CPTAxisLabel.m</li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="interface_c_p_t_axis_label.html">CPTAxisLabel</a>      </li>

    <li class="footer">Generated by <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a></li>
   </ul>
 </div>


</body>
</html>
